home *** CD-ROM | disk | FTP | other *** search
/ Sunday Savers: Singing Fun! / Sunday Savers: Singing Fun!.iso / mac / Xtras / Buddy API 1.6 / Buddy API Docs.swf / texts / 1666.txt < prev    next >
Encoding:
Text File  |  2004-08-31  |  2.7 KB  |  105 lines
  1. 167
  2. --- RECORDSEPARATOR ---
  3.  
  4. --- RECORDSEPARATOR ---
  5. ChildWindowList 
  6. --- RECORDSEPARATOR ---
  7. Platform:
  8. --- RECORDSEPARATOR ---
  9.  
  10. --- RECORDSEPARATOR ---
  11. Windows
  12. --- RECORDSEPARATOR ---
  13.  
  14. --- RECORDSEPARATOR ---
  15. Description:
  16. --- RECORDSEPARATOR ---
  17.  
  18. --- RECORDSEPARATOR ---
  19. baChildWindowList returns a list of a window's child windows.
  20. --- RECORDSEPARATOR ---
  21.  
  22. --- RECORDSEPARATOR ---
  23. Usage:
  24. --- RECORDSEPARATOR ---
  25.  
  26. --- RECORDSEPARATOR ---
  27. Result = baChildWindowList( ParentWnd, Class, Caption, MatchCaption )
  28. --- RECORDSEPARATOR ---
  29.  
  30. --- RECORDSEPARATOR ---
  31. Arguments:
  32. --- RECORDSEPARATOR ---
  33.  
  34. --- RECORDSEPARATOR ---
  35. Integer, string, string, integer. 
  36. --- RECORDSEPARATOR ---
  37. ParentWnd is the window to get the children of. 
  38. --- RECORDSEPARATOR ---
  39. Class is the class of child windows to include. 
  40. --- RECORDSEPARATOR ---
  41. Caption is the window title of child windows to include. 
  42. --- RECORDSEPARATOR ---
  43. If MatchCaption is true, then Caption must match the window caption exactly (apart 
  44. --- RECORDSEPARATOR ---
  45. from case). If it is false, then any window which contains Caption will be returned. If 
  46. --- RECORDSEPARATOR ---
  47. Caption is an empty string, then MatchCaption is ignored. 
  48. --- RECORDSEPARATOR ---
  49. The function can use either or both Class and Caption arguments. If one of the 
  50. --- RECORDSEPARATOR ---
  51. arguments is empty, then only the other argument will be used in searching for the 
  52. --- RECORDSEPARATOR ---
  53. windows.
  54. --- RECORDSEPARATOR ---
  55.  
  56. --- RECORDSEPARATOR ---
  57. Returns:
  58. --- RECORDSEPARATOR ---
  59.  
  60. --- RECORDSEPARATOR ---
  61. List (Xtra) or String (UCD). 
  62. --- RECORDSEPARATOR ---
  63. Returns a list or string of all found window handles.
  64. --- RECORDSEPARATOR ---
  65.  
  66. --- RECORDSEPARATOR ---
  67. Examples:
  68. --- RECORDSEPARATOR ---
  69.  
  70. --- RECORDSEPARATOR ---
  71. Director: 
  72. --- RECORDSEPARATOR ---
  73. set wndList = baChildWindowList( 1234, "", "", 0 ) -- return list of all child windows 
  74. --- RECORDSEPARATOR ---
  75. of window 1234 
  76. --- RECORDSEPARATOR ---
  77. Authorware: 
  78. --- RECORDSEPARATOR ---
  79. wndList := baChildWindowList( 1234, "Edit", "", 0 ) -- return list of all edit controls of 
  80. --- RECORDSEPARATOR ---
  81. window 1234
  82. --- RECORDSEPARATOR ---
  83.  
  84. --- RECORDSEPARATOR ---
  85. Notes:
  86. --- RECORDSEPARATOR ---
  87.  
  88. --- RECORDSEPARATOR ---
  89. The return for the UCD version is a string with each window handle on a separate 
  90. --- RECORDSEPARATOR ---
  91. line. You can use the Authorware GetLine function to retrieve each window handle. 
  92. --- RECORDSEPARATOR ---
  93. This function will return all child windows of the parent window and all its' children.
  94. --- RECORDSEPARATOR ---
  95.  
  96. --- RECORDSEPARATOR ---
  97. See also:
  98. --- RECORDSEPARATOR ---
  99.  
  100. --- RECORDSEPARATOR ---
  101. baFindWindow 
  102. --- RECORDSEPARATOR ---
  103. baWindowList 
  104. --- RECORDSEPARATOR ---
  105. baGetWindow